Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #333

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #333

wants to merge 1 commit into from

Conversation

Trojan-254
Copy link

In this update, i have expanded the README.md documentation for the env_logger crate to provide a more comprehensive and user-friendly guide. The following changes and enhancements have been made:

Enhanced Introduction: I have clarified the purpose and appropriate use cases for env_logger, emphasizing its utility in executable projects and recommending the use of the log crate for libraries.

Detailed Usage Instructions:

Dependency Setup: Expanded instructions on adding both log and env_logger crates to your project dependencies using cargo add.
Initialization: Provided guidance on initializing env_logger as early as possible in your project, with clear examples demonstrating the logging process.
Environment Variable Configuration: Included detailed explanations on how to configure logging levels using the RUST_LOG environment variable, with examples showcasing different level configurations.
Logging Levels Explained:

A comprehensive table has been added to explain the different logging levels (error, warn, info, debug, trace), along with their appropriate use cases.

These additions aim to make the documentation more informative and accessible, helping users get the most out of the env_logger crate, whether they are new to Rust logging or experienced developers looking to optimize their application's logging setup.

Copy link
Author

@Trojan-254 Trojan-254 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review

@epage
Copy link
Contributor

epage commented Sep 3, 2024

A lot of the existing README is duplicating https://docs.rs/env_logger/latest/env_logger/ and this is expanding it further. I would be inclined to consider what improvements should be made to https://docs.rs/env_logger/latest/env_logger/ and instead have the README show a simple example, pointing people to https://docs.rs/env_logger/latest/env_logger/ for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants